ISSDK  1.8
IoT Sensing Software Development Kit
docs/apirm/ISSDK_Functional_Interface.md
Go to the documentation of this file.
1 ISSDK Functional Interface (Sensor Driver API) {#functionalapis}
2 ==============================================
3 <P>Each Sensor Driver is unique to that driver. There is no abstraction, just a simple set of up to four functions for each sensor: Initialize, Configure, ReadData, and Deinit.
4 ISSDK support following Functional Interface (Sensor Driver API).
5 
6 FXLS8964AF Functional Interface
7 -------------------------------
8 Function | Description
9 ---------|------------
10 [FXLS896x_I2C_Initialize](@ref FXLS896x_I2C_Initialize(fxls896x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t *whoAmi)) | The interface function to initialize the FXLS8964AF sensor
11 [FXLS896x_I2C_Configure](@ref FXLS896x_I2C_Configure(fxls896x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8964AF sensor
12 [FXLS896x_I2C_ReadData](@ref FXLS896x_I2C_ReadData(fxls896x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8964AF sensor data
13 [FXLS896x_I2C_DeInit](@ref FXLS896x_I2C_DeInit(fxls896x_i2c_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8964AF sensor.
14 [FXLS896x_SPI_Initialize](@ref FXLS896x_SPI_Initialize(fxls896x_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t *whoAmi)) | The interface function to initialize the FXLS8964AF sensor
15 [FXLS896x_SPI_Configure](@ref FXLS896x_SPI_Configure(fxls896x_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8964AF sensor
16 [FXLS896x_SPI_ReadData](@ref FXLS896x_SPI_ReadData(fxls896x_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8964AF sensor data
17 [FXLS896x_SPI_Deinit](@ref FXLS896x_SPI_Deinit(fxls896x_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8964AF sensor.
18 
19 
20 FXAS21002 Functional Interface
21 -------------------------------
22 Function | Description
23 ---------|------------
24 [FXAS21002_I2C_Initialize](@ref FXAS21002_I2C_Initialize(fxas21002_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXAS21002 sensor
25 [FXAS21002_I2C_Configure](@ref FXAS21002_I2C_Configure(fxas21002_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXAS21002 sensor
26 [FXAS21002_I2C_ReadData](@ref FXAS21002_I2C_ReadData(fxas21002_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXAS21002 sensor data
27 [FXAS21002_I2C_Deinit](@ref FXAS21002_I2C_Deinit(fxas21002_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXAS21002 sensor.
28 
29 FXLS8962 Functional Interface
30 -------------------------------
31 Function | Description
32 ---------|------------
33 [FXLS8962_I2C_Initialize](@ref FXLS8962_I2C_Initialize(fxls8962_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t *whoAmi)) | The interface function to initialize the FXLS8962 sensor
34 [FXLS8962_I2C_Configure](@ref FXLS8962_I2C_Configure(fxls8962_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8962 sensor
35 [FXLS8962_I2C_ReadData](@ref FXLS8962_I2C_ReadData(fxls8962_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXLS8962 sensor data
36 [FXLS8962_I2C_DeInit](@ref FXLS8962_I2C_DeInit(fxls8962_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXLS8962 sensor.
37 [FXLS8962_SPI_Initialize](@ref FXLS8962_SPI_Initialize(fxls8962_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t *whoAmi)) | The interface function to initialize the FXLS8962 sensor
38 [FXLS8962_SPI_Configure](@ref FXLS8962_SPI_Configure(fxls8962_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8962 sensor
39 [FXLS8962_SPI_ReadData](@ref FXLS8962_SPI_ReadData(fxls8962_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXLS8962 sensor data
40 [FXLS8962_SPI_Deinit](@ref FXLS8962_SPI_Deinit(fxls8962_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8962 sensor.
41 
42 FXOS8700 Functional Interface
43 -------------------------------
44 Function | Description
45 ---------|------------
46 [FXOS8700_I2C_Initialize](@ref FXOS8700_I2C_Initialize(fxos8700_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXOS8700 sensor
47 [FXOS8700_I2C_Configure](@ref FXOS8700_I2C_Configure(fxos8700_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXOS8700 sensor
48 [FXOS8700_I2C_ReadData](@ref FXOS8700_I2C_ReadData(fxos8700_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXOS8700 sensor data
49 [FXOS8700_I2C_Deinit](@ref FXOS8700_I2C_Deinit(fxos8700_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXOS8700 sensor.
50 
51 MPL3115 Functional Interface
52 -------------------------------
53 Function | Description
54 ---------|------------
55 [MPL3115_I2C_Initialize](@ref MPL3115_I2C_Initialize(mpl3115_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MPL3115 sensor
56 [MPL3115_I2C_Configure](@ref MPL3115_I2C_Configure(mpl3115_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MPL3115 sensor
57 [MPL3115_I2C_ReadData](@ref MPL3115_I2C_ReadData(mpl3115_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MPL3115 sensor data
58 [MPL3115_I2C_DeInit](@ref MPL3115_I2C_DeInit(mpl3115_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MPL3115 sensor.
59 
60 MAG3110 Functional Interface
61 -------------------------------
62 Function | Description
63 ---------|------------
64 [MAG3110_I2C_Initialize](@ref MAG3110_I2C_Initialize(mag3110_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MAG3110 sensor
65 [MAG3110_I2C_Configure](@ref MAG3110_I2C_Configure(mag3110_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MAG3110 sensor
66 [MAG3110_I2C_ReadData](@ref MAG3110_I2C_ReadData(mag3110_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MAG3110 sensor data
67 [MAG3110_I2C_DeInit](@ref MAG3110_I2C_DeInit(mag3110_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MAG3110 sensor.
68 
69 MMA865x Functional Interface
70 -------------------------------
71 Function | Description
72 ---------|------------
73 [MMA865x_I2C_Initialize](@ref MMA865x_I2C_Initialize(mma865x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MMA865X sensor
74 [MMA865x_I2C_Configure](@ref MMA865x_I2C_Configure(mma865x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MMA865X sensor
75 [MMA865x_I2C_ReadData](@ref MMA865x_I2C_ReadData(mma865x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MMA865X sensor data
76 [MMA865x_I2C_DeInit](@ref MMA865x_I2C_DeInit(mma865x_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MMA865X sensor.
77 
78 MMA8491Q Functional Interface
79 -------------------------------
80 Function | Description
81 ---------|------------
82 [MMA8491Q_I2C_Initialize](@ref MMA8491Q_I2C_Initialize(mma8491q_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C* pBus, uint8_t index, uint16_t sAddress)) | The interface function to initialize the MMA8491Q sensor
83 [MMA8491Q_I2C_ReadData](@ref MMA8491Q_I2C_ReadData(mma8491q_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MMA8491Q sensor data
84 
85 FXLS8471Q Functional Interface
86 -------------------------------
87 Function | Description
88 ---------|------------
89 [FXLS8471Q_SPI_Initialize](@ref FXLS8471Q_SPI_Initialize(fxls8471q_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t whoAmi)) | The interface function to initialize the FXLS8471Q sensor
90 [FXLS8471Q_SPI_Configure](@ref FXLS8471Q_SPI_Configure(fxls8471q_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8471Q sensor
91 [FXLS8471Q_SPI_ReadData](@ref FXLS8471Q_SPI_ReadData(fxls8471q_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXLS8471Q sensor data
92 [FXLS8471Q_SPI_Deinit](@ref FXLS8471Q_SPI_Deinit(fxls8471q_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8471Q sensor.
93 
94 FXLC95000 Functional Interface
95 -------------------------------
96 Function | Description
97 ---------|------------
98 [FXLC95000_SPI_Initialize](@ref FXLC95000_SPI_Initialize(fxlc95000_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSpiSelect, void *pSlaveSelect, void *pReset, uint16_t buildId)) | The interface function to initialize the FXLC95000 sensor in SPI mode.
99 [FXLC95000_SPI_CommandResponse](@ref FXLC95000_SPI_CommandResponse(fxlc95000_spi_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList, const registerreadlist_t *pResponseList, uint8_t *pBuffer)) | The interface function to read the FXLC95000 sensor data.
100 [FXLC95000_I2C_Initialize](@ref FXLC95000_I2C_Initialize(fxlc95000_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint16_t buildId)) | The I2C interface function to initialize the FXLC95000 sensor in I2C mode.
101 [FXLC95000_I2C_CommandResponse](@ref FXLC95000_I2C_CommandResponse(fxlc95000_i2c_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList, const registerreadlist_t *pResponseList, uint8_t *pBuffer)) | The interface function to read the FXLC95000 sensor data.
102 
103 MMA9553 Functional Interface
104 -------------------------------
105 Function | Description
106 ---------|------------
107 [MMA9553_I2C_Initialize](@ref MMA9553_I2C_Initialize(mma9553_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C* pBus, uint8_t index, uint16_t sAddress)) | The interface function to initialize the MMA9553 sensor
108 [MMA9553_I2C_Configure](@ref MMA9553_I2C_Configure(mma9553_i2c_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList)) | The interface function to configure the MMA9553 sensor
109 [MMA9553_I2C_CommandResponse](@ref MMA9553_I2C_CommandResponse(mma9553_i2c_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the MMA9553 sensor data
110 [MMA9553_I2C_DeInit](@ref MMA9553_I2C_DeInit(mma9553_i2c_sensorhandle_t *pSensorHandle)) | The interface function to stop the MMA9553 sensor.
111 
112 MMA845x Functional Interface
113 -------------------------------
114 Function | Description
115 ---------|------------
116 [MMA845x_I2C_Initialize](@ref MMA845x_I2C_Initialize(mma845x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MMA845x sensor
117 [MMA845x_I2C_Configure](@ref MMA845x_I2C_Configure(mma845x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MMA845x sensor
118 [MMA845x_I2C_ReadData](@ref MMA845x_I2C_ReadData(mma845x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MMA845x sensor data
119 [MMA845x_I2C_Deinit](@ref MMA845x_I2C_Deinit(mma845x_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MMA845x sensor.
120 
121 FXPQ3115 Functional Interface
122 -------------------------------
123 Function | Description
124 ---------|------------
125 [FXPQ3115_I2C_Initialize](@ref FXPQ3115_I2C_Initialize(fxpq3115_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXPQ3115 sensor
126 [FXPQ3115_I2C_Configure](@ref FXPQ3115_I2C_Configure(fxpq3115_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXPQ3115 sensor
127 [FXPQ3115_I2C_ReadData](@ref FXPQ3115_I2C_ReadData(fxpq3115_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXPQ3115 sensor data
128 [FXPQ3115_I2C_DeInit](@ref FXPQ3115_I2C_DeInit(fxpq3115_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXPQ3115 sensor.
129 
130 FXPS7250D4 Functional Interface
131 -------------------------------
132 Function | Description
133 ---------|------------
134 [DBAP_I2C_Initialize](@ref DBAP_I2C_Initialize(dbap_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXPS7250D4 sensor
135 [DBAP_I2C_Configure](@ref DBAP_I2C_Configure(dbap_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXPS7250D4 sensor
136 [DBAP_I2C_ReadData](@ref DBAP_I2C_ReadData(dbap_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXPS7250D4 sensor data
© Copyright 2016-2020 NXP. All Rights Reserved.